home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / HISTORY.PY < prev    next >
Encoding:
Python Source  |  2000-07-26  |  10.8 KB  |  314 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """Object Histories"""
  86.  
  87. __version__='$Revision: 1.1.14.4 $'[11:-2]
  88.  
  89. import Globals, ndiff, ExtensionClass
  90. from DateTime import DateTime
  91. from Acquisition import Implicit
  92. from string import join, split, atoi, strip
  93. from struct import pack, unpack
  94. from DocumentTemplate.DT_Util import html_quote
  95.  
  96. class TemporalParadox(Exception): pass
  97.  
  98. class HistorySelectionError(Exception): pass
  99.  
  100. class HystoryJar:
  101.     """A ZODB Connection-like object that provides access to data
  102.     but prevents history from being changed."""
  103.  
  104.     def __init__(self, base):
  105.         self.__base__=base
  106.  
  107.     def __getattr__(self, name):
  108.         return getattr(self.__base__, name)
  109.  
  110.     def commit(*args, **kw):
  111.         raise TemporalParadox, "You can\'t change history!"
  112.  
  113.     tpc_begin = tpc_finish = commit
  114.  
  115.     def abort(*args, **kw): pass
  116.  
  117. def historicalRevision(self, serial):
  118.     state=self._p_jar.oldstate(self, serial)
  119.     rev=self.__class__.__basicnew__()
  120.     rev._p_jar=HystoryJar(self._p_jar)
  121.     rev._p_oid=self._p_oid
  122.     rev._p_serial=serial
  123.     rev.__setstate__(state)
  124.     rev._p_changed=0
  125.     return rev
  126.  
  127. class Historian(Implicit):
  128.     """An Historian\'s job is to find hysterical revisions of
  129.     objects, given a time."""
  130.  
  131.     def __getitem__(self, key):
  132.         self=self.aq_parent
  133.  
  134.         serial=apply(pack, ('>HHHH',)+tuple(map(atoi, split(key,'.'))))
  135.  
  136.         if serial == self._p_serial: return self
  137.  
  138.         rev=historicalRevision(self, serial)
  139.  
  140.         return rev.__of__(self.aq_parent)
  141.  
  142.     def manage_workspace(self, REQUEST):
  143.         "We aren\'t real, so we delegate to that that spawned us!"
  144.         raise 'Redirect', REQUEST['URL2']+'/manage_change_history_page'
  145.  
  146. class Historical(ExtensionClass.Base):
  147.     """Mix-in class to provide a veiw that shows hystorical changes
  148.  
  149.     The display is similar to that used for undo, except that the transactions
  150.     are limited to those that effect the displayed object and that the
  151.     interface doesn't provide an undo capability.
  152.  
  153.     This interface is generally *only* interesting for objects, such
  154.     as methods, and documents, that are self-contained, meaning that
  155.     they don't have persistent sub-objects.
  156.     """
  157.  
  158.     HistoricalRevisions=Historian()
  159.  
  160.     __ac_permissions__=(
  161.         ('View History',
  162.          ('manage_change_history_page','manage_change_history',
  163.           'manage_historyCompare', 'manage_historicalComparison',
  164.           )
  165.          ),
  166.         )
  167.     
  168.     manage_options=({'label':'History', 'action':'manage_change_history_page',
  169.                      'help':('OFSP','History.stx')
  170.                      },
  171.                    )
  172.  
  173.     manage_change_history_page=Globals.HTMLFile(
  174.         'history', globals(),
  175.         HistoryBatchSize=20,
  176.         first_transaction=0, last_transaction=20)
  177.  
  178.     def manage_change_history(self):
  179.         first=0
  180.         last=20
  181.         request=getattr(self, 'REQUEST', None)
  182.         if request is not None:
  183.             first=request.get('first_transaction', first)
  184.             last=request.get('last_transaction',last)
  185.         
  186.  
  187.         r=self._p_jar.db().history(self._p_oid, None, last)
  188.         r=r[first:]
  189.  
  190.         for d in r:
  191.             d['time']=DateTime(d['time'])
  192.             d['key']=join(map(str, unpack(">HHHH", d['serial'])),'.')
  193.  
  194.         return r
  195.  
  196.     def manage_beforeHistoryCopy(self): pass # ? (Hook)
  197.  
  198.     def manage_historyCopy(self, keys=[], RESPONSE=None, URL1=None):
  199.         "Copy a selected revision to the present"
  200.         if not keys:
  201.             raise HistorySelectionError, (
  202.                 "No historical revision was selected.<p>")
  203.  
  204.         if len(keys) > 1:
  205.             raise HistorySelectionError, (
  206.                 "Only one historical revision can be "
  207.                 "copied to the present.<p>")
  208.  
  209.         key=keys[0]
  210.         serial=apply(pack, ('>HHHH',)+tuple(map(atoi, split(key,'.'))))
  211.  
  212.         if serial != self._p_serial:
  213.             self.manage_beforeHistoryCopy()
  214.             state=self._p_jar.oldstate(self, serial)
  215.             self.__setstate__(state)
  216.             self._p_changed=1
  217.             self.manage_afterHistoryCopy()
  218.  
  219.         if RESPONSE is not None and URL1 is not None:
  220.             RESPONSE.redirect(URL1+'/manage_workspace')
  221.  
  222.     def manage_afterHistoryCopy(self): pass # ? (Hook)
  223.  
  224.     
  225.     _manage_historyComparePage=Globals.HTMLFile(
  226.         'historyCompare', globals(), management_view='History')
  227.     def manage_historyCompare(self, rev1, rev2, REQUEST,
  228.                               historyComparisonResults=''):
  229.         dt1=DateTime(rev1._p_mtime)
  230.         dt2=DateTime(rev2._p_mtime)
  231.         return self._manage_historyComparePage(
  232.             self, REQUEST,
  233.             dt1=dt1, dt2=dt2,
  234.             historyComparisonResults=historyComparisonResults)
  235.  
  236.     def manage_historicalComparison(self, REQUEST, keys=[]):
  237.         "Compare two selected revisions"
  238.         if not keys:
  239.             raise HistorySelectionError, (
  240.                 "No historical revision was selected.<p>")
  241.         if len(keys) > 2:
  242.             raise HistorySelectionError, (
  243.                 "Only two historical revision can be compared<p>")
  244.         
  245.         serial=apply(pack, ('>HHHH',)+tuple(map(atoi, split(keys[-1],'.'))))
  246.         rev1=historicalRevision(self, serial)
  247.         
  248.         if len(keys)==2:
  249.             serial=apply(pack,
  250.                          ('>HHHH',)+tuple(map(atoi, split(keys[0],'.'))))
  251.  
  252.             rev2=historicalRevision(self, serial)
  253.         else:
  254.             rev2=self
  255.  
  256.         return self.manage_historyCompare(rev1, rev2, REQUEST)
  257.         
  258. Globals.default__class_init__(Historical)
  259.  
  260. def dump(tag, x, lo, hi, r):
  261.     r1=[]
  262.     r2=[]
  263.     for i in xrange(lo, hi):
  264.         r1.append(tag)
  265.         r2.append(x[i])
  266.     r.append("<tr>\n"
  267.             "<td><pre>\n%s\n</pre></td>\n"
  268.             "<td><pre>\n%s\n</pre></td>\n"
  269.             "</tr>\n"
  270.             % (join(r1,'\n'), html_quote(join(r2, '\n'))))
  271.  
  272. def replace(x, xlo, xhi, y, ylo, yhi, r):
  273.  
  274.     rx1=[]
  275.     rx2=[]
  276.     for i in xrange(xlo, xhi):
  277.         rx1.append('-')
  278.         rx2.append(x[i])
  279.  
  280.     ry1=[]
  281.     ry2=[]
  282.     for i in xrange(ylo, yhi):
  283.         ry1.append('+')
  284.         ry2.append(y[i])
  285.  
  286.  
  287.     r.append("<tr>\n"
  288.             "<td><pre>\n%s\n%s\n</pre></td>\n"
  289.             "<td><pre>\n%s\n%s\n</pre></td>\n"
  290.             "</tr>\n"
  291.             % (join(rx1, '\n'), join(ry1, '\n'),
  292.                html_quote(join(rx2, '\n')), html_quote(join(ry2, '\n'))))
  293.  
  294. def html_diff(s1, s2):
  295.     a=split(s1,'\n')
  296.     b=split(s2,'\n')
  297.     cruncher=ndiff.SequenceMatcher(isjunk=split, a=a, b=b)
  298.  
  299.     r=['<table border=1>']
  300.     for tag, alo, ahi, blo, bhi in cruncher.get_opcodes():
  301.         if tag == 'replace':
  302.             replace(a, alo, ahi, b, blo, bhi, r)
  303.         elif tag == 'delete':
  304.             dump('-', a, alo, ahi, r)
  305.         elif tag == 'insert':
  306.             dump('+', b, blo, bhi, r)
  307.         elif tag == 'equal':
  308.             dump(' ', a, alo, ahi, r)
  309.         else:
  310.             raise ValueError, 'unknown tag ' + `tag`
  311.     r.append('</table>')
  312.  
  313.     return join(r, '\n')
  314.